-
Notifications
You must be signed in to change notification settings - Fork 1.7k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
doc/user-guide: Document operator-sdk up local #261
doc/user-guide: Document operator-sdk up local #261
Conversation
Thanks for taking on this issue. I'd suggest us to wait until this #255 is resolved before we update the doc for it. |
doc/user-guide.md
Outdated
- As go program outside cluster | ||
|
||
#### 1. Run as pod inside Kubernetes cluster | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Probably mention that this is the suggested production setup, since we mention the out-cluster one is for dev and test.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
good idea, done
doc/user-guide.md
Outdated
This method is prefered during development cycle to deploy and test faster. | ||
|
||
Run the operator localy with the default kubernetes config file present at `$HOME/.kube/config` | ||
```sh |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
empty line between code block and content.
doc/user-guide.md
Outdated
``` | ||
|
||
Run the operator localy with a provided kubernetes config file | ||
```sh |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
empty line between code block and content.
def5398
to
7a61593
Compare
doc/user-guide.md
Outdated
@@ -90,6 +90,15 @@ Replace the default handler with the reference [memcached handler][memcached_han | |||
|
|||
### Build and run the operator | |||
|
|||
There is 2 ways to run the operator: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
prefer to use two
instead of 2
.
doc/user-guide.md
Outdated
- As pod inside Kubernetes cluster | ||
- As go program outside cluster | ||
|
||
#### 1. Run as pod inside Kubernetes cluster |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Run as pod inside Kubernetes cluster
-> Run as pod inside a Kubernetes cluster
doc/user-guide.md
Outdated
|
||
#### 1. Run as pod inside Kubernetes cluster | ||
|
||
Run as pod inside Kubernetes cluster is prefered for production use. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
inside Kubernetes cluster
-> inside a Kubernetes cluster
doc/user-guide.md
Outdated
INFO[0000] operator-sdk Version: 0.0.5+git | ||
``` | ||
|
||
Run the operator localy with a provided kubernetes config file |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
add :
as .. file:
to be consistent with rest of the doc.
Probably not now. I need to re-think how the readme should be like. |
7a61593
to
a3ccf38
Compare
@fanminshi No problem, If you need help to re-think the README do not hesitate to ask ;) |
@etiennecoutaud thanks. LGTM |
@etiennecoutaud you can remove |
Due to a recent issue arisen from #273, we need to indicate the watched namespace |
a3ccf38
to
0cd41b3
Compare
Update done |
@etiennecoutaud also remove the |
0cd41b3
to
f75dd7b
Compare
Yes we will update after #273 fixed |
Refers to #253
@fanminshi Should we document
operator-sdk up local
inREADME
?Feedbacks are welcome for
user-guide.md
proposal 😄